home *** CD-ROM | disk | FTP | other *** search
/ PC Media 4 / PC MEDIA CD04.iso / share / udos / rutils30 / ui.txt < prev    next >
Encoding:
Text File  |  1992-07-29  |  3.9 KB  |  77 lines
  1. ===============================================================================
  2.       I tried to design a unique user interface for all my utilities.
  3.       Its features are as follows:
  4. ===============================================================================
  5.  
  6.     o First of all: NEVER try to do something like "LOCASE TEXT.DAT > TEXT.DAT",
  7.       ie., never try to redirect output to the input file. This results in
  8.       loss of your data file. Instead, rename your input or output file before
  9.       applying the command, like
  10.             REN TEXT.DAT TMP.TMP
  11.             LOCASE TMP.TMP > TEXT.DAT
  12.             DEL TMP.TMP
  13.       [That has nothing to do with my programs, but I think, it should be said]
  14.  
  15.     o I include as much DOCUMENTATION as possible in the EXE files, so you
  16.       don't have to look into additional files like this one too often.
  17.  
  18.     o You may RENAME any of the programs to whatever name you wish. The help
  19.       pages will recognize the change and update automatically. For bug reports
  20.       please tell me the 'design name', which is shown in the -v screen, if it
  21.       differs from your choice.
  22.  
  23.     o Valid switch characters are - and /
  24.  
  25.     o A filename - stands for input from stdin. This is true only for those
  26.       utilities where input from standard input is meaningful. If you use
  27.       them as pipes, as in
  28.             DIR | NODUP -b10 -e12
  29.       you may omit the filename argument.
  30.  
  31.     o Calling any of the programs without arguments will show a help page, if
  32.       there is no meaningful application for such an invokation.
  33.  
  34.     o The option specification is case sensitive, ie. -h and -H are two
  35.       different options!
  36.  
  37.     o Each program has at least 4 options: -h and -H display help screens.
  38.       -v shows how to contact me and the version of the software. -* is
  39.       (only?) useful for me when I'm debugging (but why make a secret of
  40.       it...).
  41.  
  42.     o Options may be specified separately, like -a -b -c, or in one turn,
  43.       like -abc. If options have arguments, like -b100, they may only appear
  44.       at the end of tied-together options, ie. -ab100 is the same as -a -b100,
  45.       whereas -b100a results in 100a as argument to -b.
  46.       Options with arguments appear in the help pages with a trailing :.
  47.  
  48.     o The Errorlevel is set due to the following reasons: 0, if everything
  49.       worked ok. 1, if an information screen had been displayed. 255, if a
  50.       fatal error occured. Other settings depend on the tools functionality
  51.       and are documented in the -H screens. This helps building batch files
  52.       with the programs (IF ERRORLEVEL 255 GOTO... and so on).
  53.  
  54.     o The commandline may contain quoted strings. Quoting characters are
  55.       ' and ", respectively. The following command line
  56.             ASET A COUNT 'a"a' "b'b"
  57.       will result in A=2, because " will be part of the string in the first
  58.       ' pair and vice versa. The ! character may be used to unquote ', ", #,
  59.       and ! itself. Separators are space and tab characters. Quoted strings
  60.       without separators in between are concatenated. Thus
  61.             ASET A COUNT !'a"a' "b'b"
  62.       will return 1, namely the string >>>'aa' bb"<<<. Think about this.
  63.       Quoting may also be used to specify empty strings '', or "". Missing
  64.       quotes at the end of the line are filled up appropriately.
  65.  
  66.     o Each significant command line part may be followed by a comment part
  67.       which will not be propagated to the program. The comment begins with
  68.       a # and ends with the command line. Use !# to get the # character.
  69.  
  70.     o If not explicitly said, the order of names and options is arbitrary.
  71.       Parameter of options, like -b100 must be appended without blanks
  72.       (otherwise they are interpreted as names).
  73.  
  74.     o Currently my utilities cannot process files whose name begins with -
  75.       (unless they are part of a wildcard like *.*). You must either use
  76.       a wildcard or rename them first. Sorry.
  77.